home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 19 / CU Amiga Magazine's Super CD-ROM 19 (1998)(EMAP Images)(GB)[!][issue 1998-02].iso / CUCD / Online / hsc / examples / fetzenschaedl / README < prev    next >
Text File  |  1997-06-02  |  2KB  |  66 lines
  1. Fetzenschädl Example Project
  2. ============================
  3.  
  4. This directory contains a small example project.
  5.  
  6. It will result in exactly the same pages as those you can find in
  7. `examples/simple'. However there is a remarkable difference: Both the
  8. html documents and the hsc sources are located in the same directory
  9. tree.
  10.  
  11. This has mostly disadvantages:
  12.  
  13. - Your hsc sources will waste space on the w3-server disk.
  14. - When processing, hsc will have to access the disk of your
  15.   w3-server, resulting in an increased load.
  16. - Unless you set decent access rights of your hsc sources, they can
  17.   be loaded into a w3-browser just like normal html documents.
  18. - Objects and sources are not separated from each other, which will
  19.   make certain operations (like archiving) more difficult.
  20.  
  21. But there also is an advantage: During the first steps, it might be
  22. easier for new users to cope with this approach, as they will not have
  23. to mess around with the numerous options of hsc to specify the output.
  24.  
  25. However, you should not design projects this way because of the above
  26. mentioned reasons. Refer to `examples/simple' for a more reasonable
  27. way to achieve the same results.
  28.  
  29. Description of sources:
  30. -----------------------
  31.  
  32. main.hsc              the welcome page of this project
  33. stupid.hsc            a simple page which can be reached from "main"
  34. macro.hsc             contains some macro definitions and is
  35.                       included into all files
  36. hugo/                 a subdirectory, where all information about
  37.                       Hugo is collected
  38. hugo/hugo.hsc         some information about Hugo
  39. hugo/hugo.gif         a picture of Hugo
  40.  
  41. Starting the conversion:
  42. ------------------------
  43.  
  44. This text assumes that you are in the CLI and your current directory
  45. is "[hsc]/examples/fetzenschaedl/", with "[hsc]" being the directory
  46. where you installed this package to.
  47.  
  48. Now you are ready to start `make':
  49.  
  50.     make
  51.  
  52. Of course, you need to have a `make' command installed in your search
  53. path. See the main documentation where to obtain it.
  54.  
  55. After that, all html-objects should be ready. You can start browsing
  56. them by loading `main.html' into your browser.
  57.  
  58. Note that there does not exist a "macro.html", because the there is
  59. no rule for this in the makefile. There is no rule necessary,
  60. because "macro.hsc" is never converted alone, but only included by
  61. the other files. Additionally, "macro.hsc" contains no readable text
  62. or tags.
  63.  
  64. Take a look at the "Makefile" to understand the basic concept of hsc.
  65.  
  66.